/**
 * Copyright 2021-2022 Huawei Technologies Co., Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef MINDSPORE_CORE_OPS_TENSOR_SUMMARY_H_
#define MINDSPORE_CORE_OPS_TENSOR_SUMMARY_H_
#include <map>
#include <memory>
#include <string>

#include "mindapi/base/types.h"
#include "ops/base_operator.h"

namespace mindspore {
namespace ops {
constexpr auto kNameTensorSummary = "TensorSummary";

/// \brief Outputs a tensor to a protocol buffer through a tensor summary operator.
/// Refer to Python API @ref mindspore.ops.TensorSummary for more details.
class MIND_API TensorSummary : public BaseOperator {
 public:
  MIND_API_BASE_MEMBER(TensorSummary);
  /// \brief Constructor.
  TensorSummary() : BaseOperator(kNameTensorSummary) {}
  /// \brief Init.
  void Init();
  /// \brief Set side_effect_io.
  void set_side_effect_io();
  /// \brief Get side_effect_io.
  ///
  /// \return side_effect_io.
  bool get_side_effect_io() const;
};
}  // namespace ops
}  // namespace mindspore

#endif  // MINDSPORE_CORE_OPS_TENSOR_SUMMARY_H_
